﻿//-----------------------------------------------------------------------
// <copyright file="Job.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Base.Threading.Job
{
    using System;
    using TileTool.Base.Threading.Future;
    using TileTool.Threading.Future;
    using TileTool.Threading.Job;

    /// <summary>
    /// Abstract base class for all jobs.
    /// </summary>
    public abstract class Job : IJob
    {
        #region Fields - Private

        /// <summary>
        /// Future object for the job.
        /// </summary>
        private Future future;

        #endregion

        #region Constructor

        /// <summary>
        /// Default constructor.
        /// </summary>
        public Job()
        {
            this.future = new Future();
        }

        /// <summary>
        /// Constructor which takes a future object to use.
        /// </summary>
        /// <param name="future">Future object to use.</param>
        public Job(Future future)
        {
            if (future == null)
            {
                throw new ArgumentNullException("future", "Future object must be non-null.");
            }

            this.future = future;
        }

        #endregion

        #region Properties - Public

        /// <summary>
        /// Gets the future object associated with the job.
        /// </summary>
        public IFuture Future
        {
            get
            {
                return this.future;
            }
        }

        #endregion

        #region Methods - Public

        /// <summary>
        /// Execute the job.
        /// </summary>
        public void Execute()
        {
            try
            {
                this.HandleExecute();
                this.future.SetComplete();
            }
            catch (Exception e)
            {
                this.future.SetError(e);
            }
        }

        /// <summary>
        /// Called to handle job execution.
        /// </summary>
        public abstract void HandleExecute();

        #endregion
    }
}
